Send General Messages

Path

http://{supLink ip:port}/suplink/openapi/v1/notify

Header parameter

Parameter	Required	Description
agentId	Optional	Tenant ID. Only available for multi-tenant version
Authorization	Required	Calculated from SDK
Content-Type	Required	application/json

Body request

{
    "appId": "", //supLink app ID
    "msg": {
        "content": "string", //required. Message content
        "link": "string", //optional. Go to the link when tapping the message
        "title": "string", //Optional. Message title
        "type": "default"  //Optional. Message UI type
    },
    "toUsers": [ //required. Message receivers
        "string"
    ]
}

Response

• 200: Successful.

{
    "code": 200,
    "content": {
        "messageId": "15d6f3e1-007f-476f-b9af-c9bc04b7cc03"
    },
    "message": "success"
}

• 401

{
    "timestamp": 1685339479974,
    "path": "/suplink/openapi/v1/notify",
    "code": 401,
    "message": "Token expiration",
    "content": 401
}

Send Card Messages

Path

http://{supLink ip:port}/suplink/openapi/v1/notify

Header parameter

Parameter	Required	Description
agentId	Optional	Tenant ID. Only available for multi-tenant version
Authorization	Required	Calculated from SDK
Content-Type	Required	application/json

Body request

{
    "appId": "", //supLink app ID
    "msg": {
        "content": "string", //required. Message content
        "link": "string", //optional. Go to the link when tapping the message
        "msgType": "card_msg",//required. Message type
        "title": "string", //Optional. Message title
        "type": "default"  //Optional. Message UI type
    },
    "toUsers": [ //required. Message receivers
        "string"
    ]
}

Response

• 200: Successful.

{
    "code": 200,
    "content": {
        "messageId": "15d6f3e1-007f-476f-b9af-c9bc04b7cc03"
    },
    "message": "success"
}

• 401

{
    "timestamp": 1685339479974,
    "path": "/suplink/openapi/v1/notify",
    "code": 401,
    "message": "Token expiration",
    "content": 401
}

Send Text Messages

Path

http://{supLink ip:port}/suplink/openapi/v1/notify

Header parameter

Parameter	Required	Description
agentId	Optional	Tenant ID. Only available for multi-tenant version
Authorization	Required	Calculated from SDK
Content-Type	Required	application/json

Body request

{
    "appId": "", //supLink app ID
    "msg": {
        "content": "string", //required. Message content
        "msgType": "text_msg",//required. Message type
    },
    "toUsers": [ //required. Message receivers
        "string"
    ]
}

Response

• 200: Successful.

{
    "code": 200,
    "content": {
        "messageId": "15d6f3e1-007f-476f-b9af-c9bc04b7cc03"
    },
    "message": "success"
}

• 401

{
    "timestamp": 1685339479974,
    "path": "/suplink/openapi/v1/notify",
    "code": 401,
    "message": "Token expiration",
    "content": 401
}

Send Image Messages

Path

http://{supLink ip:port}/suplink/openapi/v1/notify

Header parameter

Parameter	Required	Description
agentId	Optional	Tenant ID. Only available for multi-tenant version
Authorization	Required	Calculated from SDK
Content-Type	Required	application/json

Body request

{
    "appId": "", //supLink app ID
    "msg": {
        "msgType": "img_msg",//required. Message type
        "resourceId": 12 // required. Returned resourceId of the image after uploading to supLink
    },
    "toUsers": [ //required. Message receivers
        "string"
    ]
}

Response

• 200: Successful.

{
    "code": 200,
    "content": {
        "messageId": "15d6f3e1-007f-476f-b9af-c9bc04b7cc03"
    },
    "message": "success"
}

• 401

{
    "timestamp": 1685339479974,
    "path": "/suplink/openapi/v1/notify",
    "code": 401,
    "message": "Token expiration",
    "content": 401
}

Send Video Messages

Path

http://{supLink ip:port}/suplink/openapi/v1/notify

Header parameter

Parameter	Required	Description
agentId	Optional	Tenant ID. Only available for multi-tenant version
Authorization	Required	Calculated from SDK
Content-Type	Required	application/json

Body request

{
    "appId": "", //supLink app ID
    "msg": {
        "msgType": "video_msg",//required. Message type
        "resourceId": 12 // required. Returned resourceId of the video after uploading to supLink
    },
    "toUsers": [ //required. Message receivers
        "string"
    ]
}

Response

• 200: Successful.

{
    "code": 200,
    "content": {
        "messageId": "15d6f3e1-007f-476f-b9af-c9bc04b7cc03"
    },
    "message": "success"
}

• 401

{
    "timestamp": 1685339479974,
    "path": "/suplink/openapi/v1/notify",
    "code": 401,
    "message": "Token expiration",
    "content": 401
}

Send Voice Messages

Path

http://{supLink ip:port}/suplink/openapi/v1/notify

Header parameter

Parameter	Required	Description
agentId	Optional	Tenant ID. Only available for multi-tenant version
Authorization	Required	Calculated from SDK
Content-Type	Required	application/json

Body request

{
    "appId": "", //supLink app ID
    "msg": {
        "msgType": "voice_msg",//required. Message type
        "resourceId": 12 // required. Returned resourceId of the voice after uploading to supLink
    },
    "toUsers": [ //required. Message receivers
        "string"
    ]
}

Response

• 200: Successful.

{
    "code": 200,
    "content": {
        "messageId": "15d6f3e1-007f-476f-b9af-c9bc04b7cc03"
    },
    "message": "success"
}

• 401

{
    "timestamp": 1685339479974,
    "path": "/suplink/openapi/v1/notify",
    "code": 401,
    "message": "Token expiration",
    "content": 401
}

Send File Messages

Path

http://{supLink ip:port}/suplink/openapi/v1/notify

Header parameter

Parameter	Required	Description
agentId	Optional	Tenant ID. Only available for multi-tenant version
Authorization	Required	Calculated from SDK
Content-Type	Required	application/json

Body request

{
    "appId": "", //supLink app ID
    "msg": {
        "msgType": "file_msg",//required. Message type
        "resourceId": 12 // required. Returned resourceId of the file after uploading to supLink
    },
    "toUsers": [ //required. Message receivers
        "string"
    ]
}

Response

• 200: Successful.

{
    "code": 200,
    "content": {
        "messageId": "15d6f3e1-007f-476f-b9af-c9bc04b7cc03"
    },
    "message": "success"
}

• 401

{
    "timestamp": 1685339479974,
    "path": "/suplink/openapi/v1/notify",
    "code": 401,
    "message": "Token expiration",
    "content": 401
}